Document that --sqlconfig flag only supports YAML format by Copilot · Pull Request #684 · microsoft/go-sqlcmd

Copilot · 2026-01-31T19:49:27Z

Plan to add documentation/help about supported config types - COMPLETE

Investigate the issue and understand the root cause
Update the help text for the --sqlconfig flag to document supported file extensions
Update README.md to document supported config file extensions
Test the changes manually
Generate localization files
Run tests
Address initial code review feedback
Address critical review feedback: Correct documentation to reflect actual implementation
Address PR review feedback
- Clarified README wording about file extensions vs the default file
- Fixed unrelated changes in translation files (JSON escape sequences)

Changes in this commit:

README.md:
- Changed "should use" to "use" for clarity
- Explicitly mentioned the default file is "an exception" to avoid confusion
- Made it clearer that custom config files must use the extension
Translation files:
- Restored original JSON escape sequences (\u003e for >, \u003c for <)
- Kept only the intended new translation entry
- Removed unrelated formatting changes that inflated the diff

Summary

The PR now:

Accurately documents YAML-only support
Has clear, unambiguous README text about file extensions
Contains only the intended changes (no unrelated escape sequence modifications)
Preserves all existing translation entries
Passes all tests

Original prompt

This section details on the original issue you should resolve

<issue_title>Add documentation/help about supported config types</issue_title>
<issue_description>Hi, sorry for my poor English.

I'm a newer to this sqlcmd utility, version 1.8.2, trying to use configuration files with --sqlconfig option to manage connection contexts.

Seems that sqlcmd sometimes use the configuration file's extension to determine which "config type" to use.
After some rough tests, seems recognized config types are:

.yaml

.yml

.toml

.json

.ini

(maybe others?)

Using other file extensions, like .sqlconfig, running command like
sqlcmd config --sqlconfig ./myproject.sqlconfig add-endpoint --name ep1434 --address localhost --port 1434
sqlcmd will complain:

Error: Unsupported Config Type "sqlconfig"

where sqlconfig seems to be the file extension.

However, commands that read (rather than write) configuration file seem to treat the configuration file as YAML-formatted,
e.g.
sqlcmd config --sqlconfig ./myproject.sqlconfig view
I'm not sure if I'm missing something, but so far I cannot find somewhere documented this behavior.
Or maybe there's a plan adding a list of supported config type / a guide of naming a configuration file?</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes Add documentation/help about supported config types #597

💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Co-authored-by: dlevy-msft-sql <194277063+dlevy-msft-sql@users.noreply.github.com>

Copilot

Pull request overview

This PR addresses issue #597 by documenting the supported configuration file extensions for the --sqlconfig flag. Users were encountering "Unsupported Config Type" errors when using non-standard extensions like .sqlconfig without knowing which extensions are actually supported by Viper.

Changes:

Updated --sqlconfig flag help text to list supported extensions inline
Added comprehensive "Custom Configuration Files" section to README.md with examples
Regenerated translation catalogs for new localizable strings

Reviewed changes

Copilot reviewed 13 out of 14 changed files in this pull request and generated 1 comment.

File	Description
cmd/modern/root.go	Added inline documentation of supported extensions (.yaml, .yml, .json, .toml, .ini, .env, .properties) to the --sqlconfig flag help text
README.md	Added new "Custom Configuration Files" section listing all supported extensions with format names, including variants and less common formats, plus usage examples and clarifying note about unsupported extensions
internal/translations/locales/*/out.gotext.json	Regenerated translation catalogs with new help text string; non-English locales have empty translations awaiting human translation

internal/translations/locales/de-DE/out.gotext.json

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Copilot

Pull request overview

Copilot reviewed 13 out of 14 changed files in this pull request and generated 3 comments.

README.md

internal/translations/locales/zh-CN/out.gotext.json

dlevy-msft-sql · 2026-02-01T05:43:59Z

@copilot address the review comments

…tions Co-authored-by: dlevy-msft-sql <194277063+dlevy-msft-sql@users.noreply.github.com>

Co-authored-by: dlevy-msft-sql <194277063+dlevy-msft-sql@users.noreply.github.com>

Copilot · 2026-02-01T05:53:44Z

Just as a heads up, I was blocked by some firewall rules while working on your feedback. Expand below for details.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

does
- Triggering command: /tmp/go-build2543538777/b536/install.test /tmp/go-build2543538777/b536/install.test -test.testlogfile=/tmp/go-build2543538777/b536/testlog.txt -test.paniconexit0 -test.timeout=10m0s -test.v=true -I /tmp/net_C387458-ifaceassert x64/bin/go . oot}} {{.Goroot}-atomic --64 x64/bin/go -w -Wno-error -o/tmp/os_user_C-ifaceassert ux_amd64/vet -c oot}} {{.Goroot}-atomic /tmp/os_user_C18-bool ux_amd64/vet (dns block)
nonexistent.database.windows.net
- Triggering command: /tmp/sqlcmd-e2e-847287666/sqlcmd /tmp/sqlcmd-e2e-847287666/sqlcmd -G -S nonexistent.database.windows.net -d testdb -compiler=gc ndor/bin/bash -installsuffix= oot}} {{.Goroot}-atomic -- hentication-libr-buildtags list�� -e store missing tr-ifaceassert ux_amd64/vet -installsuffix= mportPath}} {{.R-atomic -- ux_amd64/vet (dns block)
nonexistent.server
- Triggering command: /tmp/sqlcmd-e2e-847287666/sqlcmd /tmp/sqlcmd-e2e-847287666/sqlcmd -S nonexistent.server -tests /tmp/go-build2543538777/b321/vet.cfg -e -compiler=gc ache/go/1.24.12/-nilfunc -installsuffix= oot}} {{.Goroot}-atomic -- nal/flags list�� -e store missing tr-ifaceassert ux_amd64/vet -installsuffix= mportPath}} {{.R-atomic -- ux_amd64/vet (dns block)
- Triggering command: `/tmp/sqlcmd-e2e-847287666/sqlcmd /tmp/sqlcmd-e2e-847287666/sqlcmd -C -S nonexistent.server /tmp/go-build2543538777/b436/vet.cfg -I /tmp/os_user_C18-ifaceassert ache/go/1.24.12/-nilfunc . oot}}
  {{.Goroot}-test.testlogfile=/tmp/go-build3625500898/b001/testlog.txt --64 /v1.20.0 -W -I store missing translations

Co-authored-by: dlevy-msft-sql <194277063+dlevy-msft-sql@users.norep-o ux_amd64/vet . mportPath}}
{{.R-atomic --64 ux_amd64/vet` (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled

Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

Copilot

Pull request overview

Copilot reviewed 13 out of 13 changed files in this pull request and generated 3 comments.

README.md

cmd/modern/root.go

README.md

dlevy-msft-sql · 2026-02-01T06:02:38Z

@copilot fix the items in the review

Copilot

Pull request overview

Copilot reviewed 13 out of 13 changed files in this pull request and generated no new comments.

Copilot

Pull request overview

Copilot reviewed 13 out of 13 changed files in this pull request and generated no new comments.

dlevy-msft-sql

PR #684 Review: Document that --sqlconfig flag only supports YAML format

What the PR Does

Updates --sqlconfig flag help text in cmd/modern/root.go:
- Before: "configuration file"
- After: "configuration file (YAML format, use .yaml or .yml extension)"
Adds README documentation explaining custom config file usage with examples
Updates translation files with the new string (+ fixes unrelated JSON escape changes for >= and <command>)
Fixes missing newlines at EOF in all translation files

Potential Issues to Consider

📋 Minor: The documentation could be clearer

The README states files "should use the .yaml or .yml extension" but the default ~/.sqlcmd/sqlconfig has no extension. This is documented in the Note, but the wording could be confusing.

⚠️ Unrelated changes in translation files

The PR changes \u003e= to >= and \u003ccommand\u003e to <command> in all translation files. While these are cosmetic (JSON escape sequences for >, <), they shouldn't affect functionality, but they inflate the diff and are unrelated to the stated purpose.

✅ Missing newline fixes are fine

Adding the missing newline at EOF is a good housekeeping change.

🤔 Consider: Should the code validate the file extension?

The PR documents the YAML requirement, but if users use an unsupported extension, they'll still get a confusing error. A future enhancement could add validation or a warning.

Verdict

The PR accomplishes its stated goal of documenting the YAML-only limitation. The changes are minimal and correct. The translation file changes are slightly noisy but harmless. Looks good to merge once taken out of draft status.

dlevy-msft-sql · 2026-02-01T23:49:30Z

@copilot address the feedback in my review

… changes Co-authored-by: dlevy-msft-sql <194277063+dlevy-msft-sql@users.noreply.github.com>

Copilot · 2026-02-01T23:53:12Z

@copilot address the feedback in my review

Addressed in commit 1440de1:

README clarification: Changed wording from "should use" to "use" and explicitly noted the default file is "an exception" to avoid confusion about extensions.
Unrelated translation changes: Fixed JSON escape sequences - restored \u003e and \u003c escaping for > and < characters that were accidentally unescaped when manually adding the new translation entry.

The diff is now focused on just the intended documentation changes.

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

does
- Triggering command: /tmp/go-build609210551/b536/install.test /tmp/go-build609210551/b536/install.test -test.testlogfile=/tmp/go-build609210551/b536/testlog.txt -test.paniconexit0 -test.timeout=10m0s -test.v=true g_.a lliptic/elliptic.go ux_amd64/compile (dns block)
nonexistent.database.windows.net
- Triggering command: /tmp/sqlcmd-e2e-389345408/sqlcmd /tmp/sqlcmd-e2e-389345408/sqlcmd -G -S nonexistent.database.windows.net -d testdb (dns block)
nonexistent.server
- Triggering command: /tmp/sqlcmd-e2e-389345408/sqlcmd /tmp/sqlcmd-e2e-389345408/sqlcmd -S nonexistent.server -tests /tmp/go-build609210551/b462/vet.cfg 1627803/b056/_pkg_.a (dns block)
- Triggering command: /tmp/sqlcmd-e2e-389345408/sqlcmd /tmp/sqlcmd-e2e-389345408/sqlcmd -C -S nonexistent.server /tmp/go-build609210551/b496/vet.cfg .10.0/internal/time.go .10.0/internal/timeformattype_st--gdwarf2 x64/pkg/tool/linux_amd64/compile--64 (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Configure Actions setup steps to set up my environment, which run before the firewall is enabled
Add the appropriate URLs or hosts to the custom allowlist in this repository's Copilot coding agent settings (admins only)

dlevy-msft-sql · 2026-02-02T00:17:39Z

@copilot create new issue for The PR documents the YAML requirement, but if users use an unsupported extension, they'll still get a confusing error. A future enhancement could add validation or a warning.

Copilot · 2026-02-02T00:18:39Z

@copilot create new issue for The PR documents the YAML requirement, but if users use an unsupported extension, they'll still get a confusing error. A future enhancement could add validation or a warn...

I don't have the ability to create GitHub issues directly. However, here's the issue content that can be created:

Title: Add validation/warning for unsupported config file extensions

Description:
Currently, when users specify a config file with an unsupported extension (e.g., --sqlconfig myfile.txt), they receive a confusing Viper error: "Unsupported Config Type 'txt'".

Proposed Enhancement:
Add validation in internal/config/viper.go to check the file extension before passing to Viper and provide a clearer error message such as:

Error: Configuration files must use YAML format with .yaml or .yml extension.
The file 'myfile.txt' has an unsupported extension '.txt'.

Related:

Issue Add documentation/help about supported config types #597 - Original documentation request
PR Document that --sqlconfig flag only supports YAML format #684 - Documents YAML-only requirement

Implementation Notes:

Check file extension in configureViper() or SetFileName() function
Allow .yaml, .yml, and no extension (for default ~/.sqlcmd/sqlconfig)
Provide helpful error message pointing users to documentation

Copilot

Pull request overview

Copilot reviewed 13 out of 13 changed files in this pull request and generated no new comments.

Initial plan

3f0900a

Copilot AI assigned Copilot and dlevy-msft-sql Jan 31, 2026

Copilot started work on behalf of dlevy-msft-sql January 31, 2026 19:52 View session

Copilot AI and others added 2 commits January 31, 2026 19:57

Add documentation for supported config file extensions

e3d9c23

Co-authored-by: dlevy-msft-sql <194277063+dlevy-msft-sql@users.noreply.github.com>

Clarify read vs write behavior and add all supported extensions

c1203ce

Co-authored-by: dlevy-msft-sql <194277063+dlevy-msft-sql@users.noreply.github.com>

Copilot AI changed the title ~~[WIP] Add documentation for supported config types~~ Document supported config file extensions for --sqlconfig flag Jan 31, 2026

Copilot AI requested a review from dlevy-msft-sql January 31, 2026 20:00

Copilot finished work on behalf of dlevy-msft-sql January 31, 2026 20:00

dlevy-msft-sql requested a review from Copilot February 1, 2026 03:52

Copilot started reviewing on behalf of dlevy-msft-sql February 1, 2026 03:53 View session

dlevy-msft-sql added bug Something isn't working Size: S Small issue (less than one week effort) needs-work labels Feb 1, 2026

Copilot AI reviewed Feb 1, 2026

View reviewed changes

internal/translations/locales/de-DE/out.gotext.json Outdated Show resolved Hide resolved

Update internal/translations/locales/de-DE/out.gotext.json

d8f5851

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

dlevy-msft-sql requested a review from Copilot February 1, 2026 05:36

Copilot started reviewing on behalf of dlevy-msft-sql February 1, 2026 05:36 View session

Copilot AI reviewed Feb 1, 2026

View reviewed changes

README.md Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

internal/translations/locales/zh-CN/out.gotext.json Outdated Show resolved Hide resolved

Copilot started work on behalf of dlevy-msft-sql February 1, 2026 05:44 View session

Copilot AI and others added 2 commits February 1, 2026 05:50

Address review comments: Remove .hcl/.tfvars, restore missing transla…

8fd45bc

…tions Co-authored-by: dlevy-msft-sql <194277063+dlevy-msft-sql@users.noreply.github.com>

Fix German translation for configuration file string

ff25b13

Co-authored-by: dlevy-msft-sql <194277063+dlevy-msft-sql@users.noreply.github.com>

Copilot finished work on behalf of dlevy-msft-sql February 1, 2026 05:53

dlevy-msft-sql requested a review from Copilot February 1, 2026 05:55

Copilot started reviewing on behalf of dlevy-msft-sql February 1, 2026 05:56 View session

Copilot AI reviewed Feb 1, 2026

View reviewed changes

README.md Outdated Show resolved Hide resolved

cmd/modern/root.go Outdated Show resolved Hide resolved

README.md Outdated Show resolved Hide resolved

Copilot started work on behalf of dlevy-msft-sql February 1, 2026 06:02 View session

Copilot finished work on behalf of dlevy-msft-sql February 1, 2026 06:09

dlevy-msft-sql requested a review from Copilot February 1, 2026 16:28

Copilot started reviewing on behalf of dlevy-msft-sql February 1, 2026 16:29 View session

Copilot AI reviewed Feb 1, 2026

View reviewed changes

dlevy-msft-sql requested a review from Copilot February 1, 2026 17:00

Copilot started reviewing on behalf of dlevy-msft-sql February 1, 2026 17:01 View session

Copilot AI reviewed Feb 1, 2026

View reviewed changes

dlevy-msft-sql approved these changes Feb 1, 2026

View reviewed changes

Copilot started work on behalf of dlevy-msft-sql February 1, 2026 23:49 View session

Address review feedback: clarify README and fix unrelated translation…

1440de1

… changes Co-authored-by: dlevy-msft-sql <194277063+dlevy-msft-sql@users.noreply.github.com>

Copilot AI requested a review from dlevy-msft-sql February 1, 2026 23:54

Copilot finished work on behalf of dlevy-msft-sql February 1, 2026 23:54

dlevy-msft-sql requested a review from Copilot February 2, 2026 00:18

Copilot started work on behalf of dlevy-msft-sql February 2, 2026 00:18 View session

Copilot started reviewing on behalf of dlevy-msft-sql February 2, 2026 00:18 View session

Copilot finished work on behalf of dlevy-msft-sql February 2, 2026 00:19

Copilot AI reviewed Feb 2, 2026

View reviewed changes

dlevy-msft-sql mentioned this pull request Feb 2, 2026

Add validation/warning for unsupported config file extensions #690

Open

Copilot AI mentioned this pull request Feb 2, 2026

Add validation for config file extensions with clear error messages #691

Closed

13 tasks

dlevy-msft-sql marked this pull request as ready for review February 2, 2026 00:51

dlevy-msft-sql requested a review from shueybubbles February 2, 2026 00:51

dlevy-msft-sql approved these changes Feb 2, 2026

View reviewed changes

dlevy-msft-sql added in-review and removed needs-work labels Feb 2, 2026

Merge branch 'main' into copilot/add-documentation-for-config-types

694dbdb

dlevy-msft-sql removed the in-review label Feb 6, 2026

Conversation

Copilot AI commented Jan 31, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Plan to add documentation/help about supported config types - COMPLETE

Changes in this commit:

Summary

Comments on the Issue (you are @copilot in this section)

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dlevy-msft-sql commented Feb 1, 2026

Uh oh!

Copilot AI commented Feb 1, 2026

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

dlevy-msft-sql commented Feb 1, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

dlevy-msft-sql left a comment

Choose a reason for hiding this comment

PR #684 Review: Document that --sqlconfig flag only supports YAML format

What the PR Does

Potential Issues to Consider

📋 Minor: The documentation could be clearer

⚠️ Unrelated changes in translation files

✅ Missing newline fixes are fine

🤔 Consider: Should the code validate the file extension?

Verdict

Uh oh!

dlevy-msft-sql commented Feb 1, 2026

Uh oh!

Copilot AI commented Feb 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

I tried to connect to the following addresses, but was blocked by firewall rules:

Uh oh!

dlevy-msft-sql commented Feb 2, 2026

Uh oh!

Copilot AI commented Feb 2, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Copilot AI commented Jan 31, 2026 •

edited

Loading

Copilot AI commented Feb 1, 2026 •

edited

Loading